/*
 * (c) Copyright 2008, 2009 Hewlett-Packard Development Company, LP
 * All rights reserved.
 * [See end of file]
 */

package org.openjena.atlas.iterator;

import java.util.Iterator;
import java.util.NoSuchElementException;

/** Iterator over a Java base array */
public final class IteratorArray<T> implements Iterator<T>
{
    /** Iterator over all the array elements */ 
    public static <T> IteratorArray<T> create(T[] array)
    { return new IteratorArray<T>(array, 0, array.length) ; }
    
    /** Iterator over array elements from start (inclusive) to finish (exclusive) */ 
    public static <T> IteratorArray<T> create(T[] array, int start, int finish)
    { return new IteratorArray<T>(array, start, finish) ; }
    
    private int idx ;
    private int finishIdx ;
    private T[] array ;
    
    private IteratorArray(T[] array, int start, int finish) 
    {
        if ( start < 0 )
            throw new IllegalArgumentException("Start: "+start) ;

        if ( start > finish )
            throw new IllegalArgumentException("Start >= finish: "+start+" >= "+finish) ;

// Instead: truncate to array length          
//        if ( finish > array.length )
//            throw new IllegalArgumentException("Finish outside array") ;
//        
// Instead: immediate end iterator                
//        if ( start >= array.length )
//            throw new IllegalArgumentException("Start outside array") ;

        this.array = array ;
        idx = start ;
        finishIdx = finish ;
        if ( idx < 0 )
            idx = 0 ;
        if ( finishIdx > array.length ) 
            finishIdx = array.length ;
    }

    //@Override
    public boolean hasNext()
    {
//        if ( idx < 0 )
//            return false ;
        if ( idx >= finishIdx )
            return false ;
        return true ;
    }

    public T current()
    {
        if ( idx >= finishIdx )
            throw new NoSuchElementException() ;
        return array[idx] ;
    }
    
    //@Override
    public T next()
    {
        if ( ! hasNext() )
            throw new NoSuchElementException() ; 
        return array[idx++] ;
    }

    //@Override
    public void remove()
    { throw new UnsupportedOperationException("ArrayIterator") ; }
}

/*
 * (c) Copyright 2008, 2009 Hewlett-Packard Development Company, LP
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */